Hycom documentation purge by jdkublnick · Pull Request #3157 · ufs-community/ufs-weather-model

jdkublnick · 2026-03-20T18:25:56Z

Commit Queue Requirements:

This PR addresses a relevant WM issue (if not, create an issue).
All subcomponent pull requests (if any) have been reviewed by their code managers. N/A
Run the full Intel+GNU RT suite (compared to current baselines), preferably on Ursa (Derecho or Hercules are acceptable alternatives). Exceptions: documentation-only PRs, CI-only PRs, etc. N/A --> doc PR
- Commit log file w/full results from RT suite run (if applicable).
- Verify that test_changes.list indicates which tests, if any, are changed by this PR. Commit test_changes.list, even if it is empty.
Fill out all sections of this template.

Description:

Purging hycom documentation from User's Guide.

Commit Message:

* UFSWM -Purging hycom documentation from User's Guide.

Priority:

Critical Bugfix: Reason
High: Reason
Normal

Git Tracking

UFSWM:

Closes Purge HYCOM #2861

Sub component Pull Requests:

None

UFSWM Blocking Dependencies:

Blocked by #
None

Documentation:

Documentation update required.
- Relevant updates are included with this PR.
- A WM issue has been opened to track the need for a documentation update; a person responsible for submitting the update has been assigned to the issue (link issue).
Documentation update NOT required.
- Explanation:

Changes

Regression Test Changes (Please commit test_changes.list):

PR Adds New Tests/Baselines.
PR Updates/Changes Baselines.
No Baseline Changes.

Input data Changes:

None.
PR adds input data.
PR changes existing input data.

Library Changes/Upgrades:

Required
- Library names w/versions:
- Git Stack Issue (JCSDA/spack-stack#)
No Updates

Testing Log:

doc/UsersGuide/source/InputsOutputs.rst

Co-authored-by: Gillian Petro <96886803+gspetro-NOAA@users.noreply.github.com>

gspetro-NOAA · 2026-03-20T20:49:55Z

doc/UsersGuide/source/InputsOutputs.rst

     - Coupled :term:`ATM` - :term:`MOM6`- :term:`WW3` - :term:`CMEPS`
   * - HAFS-ALL
-     - Coupled :term:`CDEPS` - :term:`ATM` - :term:`HYCOM` - :term:`WW3` - :term:`CMEPS`
+     - Coupled :term:`CDEPS` - :term:`ATM` - :term:`WW3` - :term:`CMEPS`


Suggested change

- Coupled :term:`CDEPS` - :term:`ATM` - :term:`WW3` - :term:`CMEPS`

- Coupled :term:`CDEPS` - :term:`ATM` - :term:`MOM6` - :term:`WW3` - :term:`CMEPS`

Doesn't make sense to have a hurricane test with no ocean model ;) MOM6 replaces HYCOM in tests that aren't deleted.

There are tests with "hafs" in the name which do not include OCN. There are several ATM only as well as an ATM-WAV.

Yes, we list ATM and ATMW as separate configurations in this table near the top, and HAFS, HAFSW, HAFS-MOM6W, and HAFS-ALL are each listed, but @jdkublnick we are missing HAFS-MOM6. And I would think HAFS-ALL would switch from HYCOM to MOM6, right? That's the edit I was trying to make here. But I'm also wondering if this entire table may have outlived its usefulness... I mean, in theory, people could build experiments for any combination of WM components if they wanted, and the existing list in CMakeLists.txt just keeps expanding. It might make more sense to nix the list and send them to the relevant file for the list of APPs. And/or to rt.conf to see what particular tests are compiled with which -DAPP flag. If we keep the list, I think the key for @jdkublnick is going to be to check the tests for each relevant compile in rt.conf rather than just taking out HYCOM and assuming it'll still be valid and non-redundant (unless you can think of a better way?).

@jdkublnick It looks like the details on each APP and what components are available with each are listed in cmake/configure_apps.cmake. Maybe Denise has a different suggestion, but that looks to me like the clearest place to get the full list of APPs and corresponding components. It might be best just to go over this whole table and makes sure everything's covered and accurate/up-to-date.

gspetro-NOAA · 2026-03-20T20:52:07Z

doc/UsersGuide/source/InputsOutputs.rst

   * - hycom1_25.nc
     - vertical coordinate thickness defining 25 vertical levels
     - 9.00, 5.00
     -
-   * - hycom1_75_800m.nc 
+   * - hycom1_75_800m.nc


@DeniseWorthen Are these two files used by MOM6 despite their name? They're listed in the MOM6 section of the docs.

Yes, despite the name, they are used by MOM6 to set the vertical grid.

It could be good to look at changing that... Not a pressing issue, but maybe next time there's a new input data directory for other reasons, it could be considered? 🤔 Not sure to what extent changing the naming would have an outsized impact on other code/tests tho, so if we need to keep it as-is, that's fine.

gspetro-NOAA · 2026-03-20T20:53:54Z

doc/UsersGuide/source/InputsOutputs.rst

-   * - hycom_YYYYMM_surf_nolev.nc
-     - MOM6 forcing file for year YYYY and month MM
-     - ✔


@DeniseWorthen @NickSzapiro-NOAA Is this file still used by CICE? The description indicates that despite the name, it's a MOM6 forcing file.

Sorry ... where do you see this is related to CICE? Usage in RTs seems more CDEPS docn ocn_data

Oops, you're right! I scrolled up too far. It was a CDEPS thing; wondering if it still is.

I imagine these are SSTs from a Hycom run and are now "data" input coupled to ATM in RT

gspetro-NOAA · 2026-03-20T20:59:22Z

doc/UsersGuide/source/BuildingAndRunning.rst

@@ -390,7 +389,7 @@ Lastly, the :wm-repo:`test configuration file <blob/develop/tests/tests/hafs_reg
   export INPUT_NML=input_regional_hafs.nml.IN
   export MODEL_CONFIGURE=model_configure_hafs.IN
   export UFS_CONFIGURE=ufs.configure.hafs_atm_ocn_wav.IN
-   export FV3_RUN="hafs_fv3_run.IN hycom_hat10_run.IN hafs_ww3_run.IN"


I think in this section of the docs, you actually need to copy-paste from a different test because the test that this sample is based on (hafs_regional_atm_ocn_wav) is getting deleted in Denise's PR, and even if it weren't, you probably can't just omit that file. It would likely need a replacement, tho I'd have to look into it further.
Her PR adds: tests/tests/hafs_regional_storm_following_1nest_atm_ocn_wav_mom6_debug
So maybe you could look at the configuration for that one?

Joshua Kublnick and others added 2 commits March 20, 2026 14:21

purging hycom from the User's Guide

cc0c605

Merge branch 'ufs-community:develop' into text/hycomdocpurge

69a9813

github-project-automation bot added this to PRs to Process Mar 20, 2026

github-project-automation bot moved this to Evaluating in PRs to Process Mar 20, 2026

jdkublnick changed the title ~~Text/hycomdocpurge~~ Hycom documentation purge Mar 20, 2026

jdkublnick marked this pull request as ready for review March 20, 2026 18:28

jdkublnick mentioned this pull request Mar 20, 2026

Purge Hycom; Add HAFS IntelLLVM test #3145

Open

24 tasks

DeniseWorthen reviewed Mar 20, 2026

View reviewed changes

doc/UsersGuide/source/InputsOutputs.rst Show resolved Hide resolved

Adding back in pertinent info

7df8b77

gspetro-NOAA reviewed Mar 20, 2026

View reviewed changes

doc/UsersGuide/source/InputsOutputs.rst Outdated Show resolved Hide resolved

gspetro-NOAA reviewed Mar 20, 2026

View reviewed changes

doc/UsersGuide/source/InputsOutputs.rst Outdated Show resolved Hide resolved

jdkublnick and others added 2 commits March 20, 2026 16:49

Update doc/UsersGuide/source/InputsOutputs.rst

1c3daa8

Co-authored-by: Gillian Petro <96886803+gspetro-NOAA@users.noreply.github.com>

Update doc/UsersGuide/source/InputsOutputs.rst

16f092b

Co-authored-by: Gillian Petro <96886803+gspetro-NOAA@users.noreply.github.com>

gspetro-NOAA reviewed Mar 20, 2026

View reviewed changes

gspetro-NOAA added documentation Improvements or additions to documentation No Baseline Change No Baseline Change labels Mar 20, 2026

	- Coupled :term:`CDEPS` - :term:`ATM` - :term:`WW3` - :term:`CMEPS`
	- Coupled :term:`CDEPS` - :term:`ATM` - :term:`MOM6` - :term:`WW3` - :term:`CMEPS`

Conversation

jdkublnick commented Mar 20, 2026 • edited by gspetro-NOAA Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Commit Queue Requirements:

Description:

Commit Message:

Priority:

Git Tracking

UFSWM:

Sub component Pull Requests:

UFSWM Blocking Dependencies:

Documentation:

Changes

Regression Test Changes (Please commit test_changes.list):

Input data Changes:

Library Changes/Upgrades:

Testing Log:

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gspetro-NOAA Mar 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

jdkublnick commented Mar 20, 2026 •

edited by gspetro-NOAA

Loading

gspetro-NOAA Mar 21, 2026 •

edited

Loading